omnichannel-ux

(0 reviews)

Fetch Consent Details

[GET]

/{businessId}/partyPrivacyProfile/{id}

This usecase is to retrieve consent information of a customer from CRM(Liberate|Cerillion) system.

URL

http://[host]:[port]/omnichannel-ux/{version}/{businessId}/partyPrivacyProfile/{id}

URI Params

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y
id	string	Identifier of the Resource. The leagacy system identify the profile based on billing account.	Y

Headers

name	type	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

Response

{
   "id":"54647849",
   "name":"",
   "partyPrivacyProfileCharacteristic":[
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToSMS",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToEmail",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToCalls",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToSurvey",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "subscribeToAll",
      "valueType": "string",
      "value": "Yes",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "smsStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "smsEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "emailStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "emailEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "callsStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "callsEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "surveyStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "surveyEndDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
  {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "allConsentStartDate",
      "valueType": "string",
      "value": "2025-04-01",
      "@type": "StringCharacteristic"
    }
  },
   {
    "@type": "PartyPrivacyProfileCharacteristic",
    "characteristic": {
      "name": "allConsentEndDate",
      "valueType": "string",
      "value": "2025-07-01",
      "@type": "StringCharacteristic"
    }
  }
],
    "@type":"PartyPrivacyProfile"
}